/* Copyright 2022-2024 Romain Serra
 * Licensed to CS GROUP (CS) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * CS licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.orekit.control.indirect.shooting.propagation;

import org.hipparchus.CalculusFieldElement;
import org.hipparchus.Field;
import org.orekit.propagation.integration.AdditionalDerivativesProvider;
import org.orekit.propagation.integration.FieldAdditionalDerivativesProvider;

/**
 * Interface for adjoint derivatives provider (both standard and Field).
 *
 * @author Romain Serra
 * @since 12.2
 */
public interface AdjointDynamicsProvider {

    /**
     * Getter for adjoint vector name.
     * @return name
     */
    String getAdjointName();

    /**
     * Builds adjoint derivatives provider.
     * @return derivatives provider
     */
    AdditionalDerivativesProvider buildAdditionalDerivativesProvider();

    /**
     * Builds Field adjoint derivatives provider.
     * @param <T> field type
     * @param field input field
     * @return derivatives provider
     */
    <T extends CalculusFieldElement<T>> FieldAdditionalDerivativesProvider<T> buildFieldAdditionalDerivativesProvider(Field<T> field);
}
